home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / dev / debug / MemWatcher1_0.lha / memwatcher / MemWatcher.Doc next >
Encoding:
Text File  |  1995-04-02  |  4.5 KB  |  126 lines
  1. MemWatcher 1.0
  2.  
  3. (c)1995 Frank Brandau
  4.  
  5.  
  6. Short
  7. -----
  8.  
  9. As a debugging utility, MemWatcher displays memory usage.
  10.  
  11.  
  12. Usage
  13. -----
  14.  
  15. Start  it  and  watch memory consumation of other programs.  After exiting,
  16. every  program  should free all of its allocated memory.  Wasting memory is
  17. not  acceptable  in  the  multitasking  environment the Amiga provides.  So
  18. check your own programs to free all memory after leaving.
  19.  
  20. MemWatcher   displays  memory  differences  after  timed  intervalls  (Dos:
  21. Delay(Timebase)).   To  adjust  the  display, you can hit the lower part of
  22. MemWatcher,  the memory difference is then set to zero.  The amount of free
  23. memory  is  internally  read with AvailMem.  If there is no difference, the
  24. colour  will  change  and  will  also  if  the difference gets greater than
  25. approximately  2.2  Megs.   MemWatcher  shows  memory consumption, positive
  26. values are used memory.
  27.  
  28. After  starting  MemWatch, run the program you wish to check.  Close it and
  29. set  MemWatch  to  zero.   Run your program again and quit.  See any memory
  30. left  allocated?   Then  go  into development again.  You have to start and
  31. exit  a program before, because it normally uses libraries or fonts or devs
  32. or  i  don't  know  what  which  could remain open and thus consume memory.
  33. Running  the  program again means that every resource is already in memory,
  34. so all consumptions are due to your own program.
  35.  
  36. Another  way  of  using  MemWatcher  is  to  watch  memory  consumption  of
  37. subroutines, thus analysing memory performance of often used funktions.
  38.  
  39. The display is logarithmic, to better show small amounts of memory usage.
  40.  
  41.  
  42. ToolTypes
  43. ---------
  44.  
  45. Following ToolTypes are supported by MemWatcher:
  46.  
  47.   PubScreen=...   : Name of the Public Screen MemWatcher is opening on
  48.                     (If screen is not valid, MemWatcher will quit quietly)
  49.   XPos=...        : Initially horizontal position of window
  50.   YPos=...        : Initially vertical position of window
  51.   Timebase=...    : Output speed, value used for delay
  52.   Display=...     : Display width of window
  53.  
  54.  
  55. The program
  56. -----------
  57.  
  58. MemWatcher  is  small,  about  10k  and  uses no more than 21k running with
  59. standart  settings.   It  is  programmed  entirely  in  Cluster,  the  most
  60. underestimated  language.   It  has no further features other than watching
  61. memory,  because  i  like  my tools efficient.  Source is included, to have
  62. some Cluster source in the public domain.
  63.  
  64. MemWatcher works under 2.x and 3.x.  I don't know if it works under earlier
  65. versions of the operating system, give it a try.
  66.  
  67.  
  68. Inspiration
  69. -----------
  70.  
  71. MemWatcher was written to replace drip, a program great in its own way, but
  72. with  some  disadvantages,  like  not  having a real workbench interface or
  73. online display.
  74.  
  75.  
  76. Bugs
  77. ----
  78.  
  79. MemWatcher  is tested with Enforcer, Mungwall and MemWatcher.  There are no
  80. known errors.
  81.  
  82. If  window  width  is  to  small to hold your font (height is automatically
  83. adjusted) then use a greater width (simple eh?).
  84.  
  85.  
  86. Disclaimer and authors info
  87. ---------------------------
  88.  
  89. This  version  of  MemWatcher is freely distributable as long as all of its
  90. files  are included in their original form without additions, deletions, or
  91. modifications  of  any  kind,  and  only  a  nominal fee is charged for its
  92. distribution.  For use in commercial products, the permission of the author
  93. is required.  Permission is granted to use this program on the Aminet CDs.
  94.  
  95. This  software  is  provided  *AS  IS* without warranty of any kind, either
  96. expressed  or implied.  By using MemWatcher, you agree to accept the entire
  97. risk  as  to  the quality and performance of the program.  If you drop your
  98. Amiga onto your cat while running MemWatcher, i will not come to remove the
  99. squeezed bits (And i am not responsible for you not having a cat either).
  100.  
  101. I like to see MemWatcher as CardWare, if you use it regulary and you happen
  102. to  like  it, then send me some Magic:  The Gathering (TM) cards, available
  103. in  Comic shops all around the world (Surely i like to have some rare).  If
  104. you  have never heard of this game, shame on you.  Try it out to experience
  105. some fun.
  106.  
  107. MemWatcher was developed by Frank Brandau
  108. (Took about 16h)
  109.  
  110. Bug reports and everything else to:
  111.  
  112. EMail:
  113.   BRANDAU@FHSERVER03.DVZ.FH-AACHEN.DE
  114.  
  115. Mail:
  116.   Frank Brandau
  117.   Wiesenstrasse 6g
  118.   52428 Jülich
  119.   Germany
  120.  
  121.  
  122. ---------------------------------------------------------------------------
  123. Another explosion, eh?  Well, you know what they say, once is happenstance,
  124. twice is coincidence...  Three times is enemy action, yes?
  125.                                                              Death Head
  126.